API Documentation
Public Member Functions | List of all members
nkWinUi::Slider Class Reference

A graphical slider. More...

Inheritance diagram for nkWinUi::Slider:
nkWinUi::Component nkExport::Exportable

Public Member Functions

 Slider (MainSystem *parentSystem)
 
 ~Slider ()
 
float getMin () const
 
float getMax () const
 
float getCurrent () const
 
std::function< bool(Slider *, float)> getValueChangeCallback () const
 
virtual void setMin (float value)
 
virtual void setMax (float value)
 
virtual void setCurrent (float value)
 
virtual void setValueChangeCallback (std::function< bool(Slider *, float)> callback)
 
- Public Member Functions inherited from nkWinUi::Component
 Component (MainSystem *parentSystem)
 
virtual ~Component ()
 
LayoutgetLayout () const
 
ThemegetTheme () const
 
nkMaths::Point getPositionInParent () const
 
nkMaths::Point getPositionInScreen () const
 
int getWidth () const
 
int getHeight () const
 
nkMaths::Rectangle getAreaInParent () const
 
nkMaths::Rectangle getAreaInScreen () const
 
virtual nkMaths::Point getBorderExtents () const
 
virtual float getBorderExtent (BORDER_KIND border) const
 
virtual int getLayoutAllowedWidth () const
 
virtual int getLayoutAllowedHeight () const
 
virtual int getLayoutAllowedOffsetX () const
 
virtual int getLayoutAllowedOffsetY () const
 
bool isInitialized () const
 
ComponentgetParentComponent () const
 
COMPONENT_TYPE getComponentType () const
 
nkMemory::StringView getComponentName () const
 
bool getVisibility () const
 
virtual nkMemory::StringView getLabel () const
 
void * getData () const
 
bool isEnabled () const
 
bool isForegroundWindow () const
 
unsigned int getZDepth () const
 
bool getVisibleOnLoad () const
 
std::function< bool(Component *)> getCloseCallback () const
 
std::function< void(Component *, bool)> getVisibilityCallback () const
 
std::function< void(Component *, const ClickEventData &)> getClickCallback () const
 
std::function< void(Component *, const WheelEventData &)> getWheelCallback () const
 
std::function< void(Component *, const KeyEventData &)> getKeyCallback () const
 
virtual LayoutsetLayout (LAYOUT_TYPE layoutType)
 
virtual void setTheme (Theme *theme)
 
virtual void setPositionInParent (nkMaths::Point position)
 
virtual void setPositionInScreen (nkMaths::Point position)
 
virtual void setSize (int width, int height)
 
virtual void setWidth (int width)
 
virtual void setHeight (int height)
 
void setMinSize (unsigned int width, unsigned int height)
 
void setMaxSize (unsigned int width, unsigned int height)
 
void setRatio (float widthOverHeight)
 
virtual void setAreaInParent (const nkMaths::Rectangle &area)
 
virtual void setAreaInScreen (const nkMaths::Rectangle &area)
 
virtual void setParentComponent (Component *parent, bool makeItVisible=true)
 
virtual void setLabel (const nkMemory::StringView &label)
 
void setComponentName (const nkMemory::StringView &name)
 
virtual void setVisibility (bool value)
 
void setData (void *data)
 
void setEnabled (bool value)
 
void setVisibleOnLoad (bool value)
 
void setCloseCallback (std::function< bool(Component *caller)> callback)
 
void setVisibilityCallback (std::function< void(Component *caller, bool visibility)> callback)
 
void setClickCallback (std::function< void(Component *caller, const ClickEventData &eventData)> callback)
 
void setWheelCallback (std::function< void(Component *caller, const WheelEventData &eventData)> callback)
 
void setKeyCallback (std::function< void(Component *caller, const KeyEventData &eventData)> callback)
 
void addChild (Component *child, bool makeItVisible=true)
 
void removeChild (Component *child)
 
void removeChild (unsigned int index)
 
ComponentgetChild (unsigned int index)
 
unsigned int getChildIndex (Component *child)
 
void unloadWithChildren ()
 
void loadWithChildren ()
 
void updateZDepth ()
 
void bringToForeground ()
 
void focusWindow ()
 
nkMaths::Point getCoordRelativeFromAbsolute (const nkMaths::Point &absCoords)
 
nkMaths::Point getCoordAbsoluteFromRelative (const nkMaths::Point &relCoords)
 
virtual void load ()=0
 
virtual void unload ()=0
 
void reload ()
 
virtual void updateWindow ()
 
nkImages::Image paintToImage (bool withFrame=false)
 
void simulateEvent (const InputDescriptor &inputDescription)
 
void onSized ()
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void exportIntrospection (nkExport::Node *rootNode)
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A graphical slider.

Current implementation is a continuous slider, only drawing the cursor over its line. The minimum is set to be on the left, while the right symbolizes the maximum. By registering a callback, it is possible to listen to any input done by a user.

Constructor & Destructor Documentation

◆ Slider()

nkWinUi::Slider::Slider ( MainSystem parentSystem)

Constructor.

Parameters
parentSystemThe parent system in which the component will live.
Remarks
See ComponentManager::createOrRetrieve().

◆ ~Slider()

nkWinUi::Slider::~Slider ( )

Destructor.

Member Function Documentation

◆ getMin()

float nkWinUi::Slider::getMin ( ) const
Returns
Currently set minimum value.

◆ getMax()

float nkWinUi::Slider::getMax ( ) const
Returns
Currently set maximum value.

◆ getCurrent()

float nkWinUi::Slider::getCurrent ( ) const
Returns
Current slider value.

◆ getValueChangeCallback()

std::function<bool(Slider*, float)> nkWinUi::Slider::getValueChangeCallback ( ) const
Returns
Currently set callback when value changes.

◆ setMin()

virtual void nkWinUi::Slider::setMin ( float  value)
virtual

Sets the minimum value for the slider.

Parameters
valueThe value to use as the minimum.

◆ setMax()

virtual void nkWinUi::Slider::setMax ( float  value)
virtual

Sets the maximum value for the slider.

Parameters
valueThe value to use as the maximum.

◆ setCurrent()

virtual void nkWinUi::Slider::setCurrent ( float  value)
virtual

Sets the current value of the slider.

Parameters
valueThe value to use as the current.
Remarks
This value can overflow, going past the minimum or maximum value, and be reflected when using the getter. However, it will be clamped visually.

◆ setValueChangeCallback()

virtual void nkWinUi::Slider::setValueChangeCallback ( std::function< bool(Slider *, float)>  callback)
virtual

Sets the callback function, called whenever the cursor is moved through UI interaction.

Parameters
callbackThe callback to use.
Remarks
This callback gets called whenever the current value of the slider is changed through interaction. The function will receive the caller, and the new value set. It should return true if the event has been processed, false if it is not the case and the event should be forwarded.

The documentation for this class was generated from the following file: